RESOLVER

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc
BSD 4.3  

NAME

res_query res_search res_mkquery res_send res_init dn_comp dn_expand - resolver routines  

SYNOPSIS

Fd #include <sys/types.h> Fd #include <netinet/in.h> Fd #include <arpa/nameser.h> Fd #include <resolv.h> Fo res_query Fa char *dname Fa int class Fa int type Fa u_char *answer Fa int anslen Fc Fo res_search Fa char *dname Fa int class Fa int type Fa u_char *answer Fa int anslen Fc Fo res_mkquery Fa int op Fa char *dname Fa int class Fa int type Fa char *data Fa int datalen Fa struct rrec *newrr Fa char *buf Fa int buflen Fc Fo res_send Fa char *msg Fa int msglen Fa char *answer Fa int anslen Fc Fn res_init Fo dn_comp Fa char *exp_dn Fa char *comp_dn Fa int length Fa char **dnptrs Fa char **lastdnptr Fc Fo dn_expand Fa u_char *msg Fa u_char *eomorig Fa u_char *comp_dn Fa u_char *exp_dn Fa int length Fc  

DESCRIPTION

These routines are used for making, sending and interpreting query and reply messages with Internet domain name servers.

Global configuration and state information that is used by the resolver routines is kept in the structure _res Most of the values have reasonable defaults and can be ignored. Options stored in _res.options are defined in resolv.h and are as follows. Options are stored as a simple bit mask containing the bitwise ``or'' of the options enabled.

RES_INIT
True if the initial name server address and default domain name are initialized (i.e., Fn res_init has been called).
RES_DEBUG
Print debugging messages.
RES_AAONLY
Accept authoritative answers only. With this option, Fn res_send should continue until it finds an authoritative answer or finds an error. Currently this is not implemented.
RES_USEVC
Use TCP connections for queries instead of UDP datagrams.
RES_STAYOPEN
Used with RES_USEVC to keep the TCP connection open between queries. This is useful only in programs that regularly do many queries. UDP should be the normal mode used.
RES_IGNTC
Unused currently (ignore truncation errors, i.e., don't retry with TCP )
RES_RECURSE
Set the recursion-desired bit in queries. This is the default. ( Fn res_send does not do iterative queries and expects the name server to handle recursion.)
RES_DEFNAMES
If set, Fn res_search will append the default domain name to single-component names (those that do not contain a dot). This option is enabled by default.
RES_DNSRCH
If this option is set, Fn res_search will search for host names in the current domain and in parent domains; see hostname(7). This is used by the standard host lookup routine gethostbyname(3). This option is enabled by default.

The Fn res_init routine reads the configuration file (if any; see resolv.conf5) to get the default domain name, search list and the Internet address of the local name server(s). If no server is configured, the host running the resolver is tried. The current domain name is defined by the hostname if not specified in the configuration file; it can be overridden by the environment variable LOCALDOMAIN This environment variable may contain several blank-separated tokens if you wish to override the Fa search list on a per-process basis. This is similar to the Fa search command in the configuration file. Another environment variable RES_OPTIONS can be set to override certain internal resolver options which are otherwise set by changing fields in the Fa _res structure or are inherited from the configuration file's Fa options command. The syntax of the RES_OPTIONS environment variable is explained in resolv.conf5. Initialization normally occurs on the first call to one of the following routines.

The Fn res_query function provides an interface to the server query mechanism. It constructs a query, sends it to the local server, awaits a response, and makes preliminary checks on the reply. The query requests information of the specified Fa type and Fa class for the specified fully-qualified domain name Fa dname . The reply message is left in the Fa answer buffer with length Fa anslen supplied by the caller.

The Fn res_search routine makes a query and awaits a response like Fn res_query , but in addition, it implements the default and search rules controlled by the RES_DEFNAMES and RES_DNSRCH options. It returns the first successful reply.

The remaining routines are lower-level routines used by Fn res_query . The Fn res_mkquery function constructs a standard query message and places it in Fa buf . It returns the size of the query, or -1 if the query is larger than Fa buflen . The query type Fa op is usually QUERY but can be any of the query types defined in Aq Pa arpa/nameser.h . The domain name for the query is given by Fa dname . Fa Newrr is currently unused but is intended for making update messages.

The Fn res_send routine sends a pre-formatted query and returns an answer. It will call Fn res_init if RES_INIT is not set, send the query to the local name server, and handle timeouts and retries. The length of the reply message is returned, or -1 if there were errors.

The Fn dn_comp function compresses the domain name Fa exp_dn and stores it in Fa comp_dn . The size of the compressed name is returned or -1 if there were errors. The size of the array pointed to by Fa comp_dn is given by Fa length . The compression uses an array of pointers Fa dnptrs to previously-compressed names in the current message. The first pointer points to to the beginning of the message and the list ends with NULL The limit to the array is specified by Fa lastdnptr . A side effect of Fn dn_comp is to update the list of pointers for labels inserted into the message as the name is compressed. If dnptr is NULL, names are not compressed. If Fa lastdnptr is NULL the list of labels is not updated.

The Fn dn_expand entry expands the compressed domain name Fa comp_dn to a full domain name The compressed name is contained in a query or reply message; Fa msg is a pointer to the beginning of the message. The uncompressed name is placed in the buffer indicated by Fa exp_dn which is of size Fa length . The size of compressed name is returned or -1 if there was an error.  

FILES

/etc/resolv.conf The configuration file see resolv.conf5.

 

SEE ALSO

gethostbyname(3), named(8), resolv.conf5, hostname(7),

RFC1032 , RFC1033 , RFC1034 , RFC1035 , RFC974

"Name Server Operations Guide for BIND"
 

HISTORY

The function appeared in BSD 4.3


 

Index

NAME
SYNOPSIS
DESCRIPTION
FILES
SEE ALSO
HISTORY

This document was created by man2html, using the manual pages.
Time: 16:28:57 GMT, April 18, 2022